Add CakeSentry.Queue.* events for Sentry integration#452
Closed
dereuromark wants to merge 1 commit intomasterfrom
Closed
Add CakeSentry.Queue.* events for Sentry integration#452dereuromark wants to merge 1 commit intomasterfrom
dereuromark wants to merge 1 commit intomasterfrom
Conversation
Dispatch events compatible with lordsimal/cakephp-sentry: - CakeSentry.Queue.enqueue: when job is added to queue - CakeSentry.Queue.beforeExecute: when job processing starts - CakeSentry.Queue.afterExecute: when job completes or fails This enables queue monitoring via Sentry without requiring the queue plugin to depend on Sentry SDK directly.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #452 +/- ##
============================================
+ Coverage 73.28% 73.65% +0.37%
- Complexity 777 778 +1
============================================
Files 41 41
Lines 2691 2725 +34
============================================
+ Hits 1972 2007 +35
+ Misses 719 718 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
7 tasks
Owner
Author
|
Closing in favor of #453 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds events compatible with lordsimal/cakephp-sentry for queue monitoring and tracing, as proposed in LordSimal/cakephp-sentry#43.
Instead of including Sentry-specific code directly in the queue plugin (as in #449), this approach dispatches generic events that the Sentry plugin can listen to:
CakeSentry.Queue.enqueue: Fired when a job is added to the queue (producer side)CakeSentry.Queue.beforeExecute: Fired when a worker begins processing a job (consumer side)CakeSentry.Queue.afterExecute: Fired when a job finishes (success or failure)This enables integration with Sentry's queue monitoring without requiring the queue plugin to depend on the Sentry SDK.
Trace Propagation
For distributed tracing, users can add Sentry trace headers to job data when creating jobs:
The queue plugin will pass these headers to the
beforeExecuteevent for trace continuation.Related Issues
Test plan
CakeSentry.Queue.enqueueeventCakeSentry.Queue.beforeExecuteeventCakeSentry.Queue.afterExecutesuccess eventCakeSentry.Queue.afterExecutefailure event